home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 151-175 / disk_161 / nag / nag.doc < prev    next >
Text File  |  1992-05-06  |  38KB  |  837 lines
  1. *********************************************************************
  2. *************************      Nag doc     **************************
  3. *********************************************************************
  4.  
  5. ******  Table of contents  ******
  6.  
  7.      1.  Overview
  8.  
  9.      2.  Requirements
  10.              2.0  Computer
  11.              2.1  Operating System
  12.              2.2  Fonts
  13.              2.3  Disclaimer
  14.              2.4  Guarantee
  15.              2.5  Assumptions
  16.      
  17.      3.  Configuration
  18.              3.0  Auto-Configuration
  19.              3.1  Editing the Configuration file.
  20.  
  21.      4.  Installation
  22.              4.0  Auto-Installation
  23.              4.1  Contents of the arc file
  24.  
  25.      5.  Start-up
  26.              5.0  From s:startup-sequence
  27.              5.1  From WORKBENCH
  28.              5.2  From CLI
  29.  
  30.      6.  Tiny Window
  31.              6.0  General Info
  32.              6.1  The BACKDROP flag
  33.              6.2  Awakening Nag
  34.  
  35.      7.  Main Display
  36.              7.0  Top Line
  37.              7.1  Appointment 'message' display
  38.              7.2  Those Colored 'Dots'
  39.              7.3  Calendar Display
  40.              7.4  CALENDAR       gadgets
  41.              7.5  NOW            gadget
  42.              7.6  NAG and 1 NAG  gadget
  43.              7.7  EDIT           gadget
  44.              7.8  PRINT          gadget
  45.              7.9  SEARCH         gadget
  46.              7.10 SHRINK         gadget
  47.              7.11 QUIT           gadget
  48.              7.12 TITLE BOX      gadget (re-configure Nag)
  49.  
  50.      8.  Editing Appointments
  51.              8.0  When are we Editing?
  52.              8.1  What are we Editing?
  53.              8.2  The "string"   gadget
  54.              8.3  /\ & \/        gadgets
  55.              8.4  AM/PM          gadget
  56.              8.5  DELETE         gadget
  57.              8.6  COPY           gadget
  58.              8.7  RECALL         gadget
  59.              8.8  Times          gadgets
  60.              8.9  Nags Per Time  gadget
  61.              8.10 VOICE & SOUND  gadgets
  62.              8.11 DONE           gadget
  63.              8.12 CANCEL         gadget
  64.              8.13 SHAREWARE      gadget (test Nag)
  65.              8.14 How To Enter New Appointments
  66.              8.15 How To Merge And Sort Files From CLI
  67.              8.16 How To Edit Other Years
  68.  
  69.      9.  Details of the Nag.year files
  70.  
  71.     10.  Known Bugs
  72.  
  73.     11.  REVISION History
  74.  
  75.     12.  Shareware Notice
  76.             12.0  The Concept 
  77.             12.1  The Pitch
  78.             12.2  The Address
  79.             12.3  Bug Reports
  80.             12.4  Distribution
  81.             12.5  The Promise
  82.  
  83. *********************************************************************
  84. *************************  1. Overview     **************************
  85. *********************************************************************
  86.  
  87.      Nag' is an electronic appointment calendar for the Amiga. In
  88. addition to keeping track of your appointments, your anniversary, and
  89. your mother-in-law's birthday, `Nag' can be instructed to gently
  90. remind you by popping up a display of the next `nagged event'. It will
  91. hang around flashing or beeping or playing a digital sample and/or
  92. using the Amiga's voice to 'NAG' (remind) you every 30 seconds until
  93. you respond.
  94.  
  95. You can also TURN THE NAG OFF! (Much better than your mother-in-law!)
  96.  
  97.  
  98.    - ******* -           - Nag Features -             - ******* -
  99.  
  100.  -> Be Nagged (reminded) with Flash, Beep, Sample, and/or Voice.
  101.  -> Set times, and types of nags for each individual event.
  102.  -> Plays ANY file as SOUND data. Will set Period from IFF format file.
  103.  -> Simple 'intuitive' gadget-driven menus follow WORKBENCH conventions.
  104.  -> Configuration file sets Nag to YOUR preferences.
  105.  -> Up to 2 years of 99 events per day. Buffer size 2 K to 2 MEGS.
  106.  -> FAST gadget-driven editor with COPY & RECALL. 'Special Date' flags.
  107.  -> Calendar gadget quickly shows any day of any month of any year.
  108.  -> Print Routine. (Assignment sheets, printout of personal Diary, etc.)
  109.  -> Search Routine.  'Missed Nags' Routine.  'SingleShot' Nag Switch.
  110.  -> The Ultimate Reminder!!!  SHAREWARE:  User = $10  -*-  & Disk = $15
  111.  
  112. *********************************************************************
  113. *************************  2. Requirements  *************************
  114. *********************************************************************
  115.  
  116.  2.0     COMPUTER:  Amiga 500, 1000, or 2000.
  117.  
  118.  2.1       SYSTEM:  WORKBENCH 1.2 set to 80 column mode.
  119.  
  120.  2.2         FONT:  Default font or custom 8x8 font. (I use Pearl).
  121.                    
  122.  2.3   DISCLAIMER:  I disclaim responsibility for anything whatsoever
  123.                     that might occur as a result of using this program.
  124.                     As a matter of fact, I disclaim any responsibility
  125.                     for the content of this disclaimer. So there...
  126.                           *** USE NAG AT YOUR OWN RISK! ***
  127.  
  128.  2.4    GUARANTEE:  I guarantee that Nag works well for me, and I will
  129.                     continue to update and revise as I deem necessary
  130.                     to try to make it work PERFECTLY for everyone. 
  131.  
  132.  2.5  ASSUMPTIONS:  Throughout this doc file, I assume that you are
  133.                     able to edit text files, using Ed or other text
  134.                     editor, and are at least familier with the Amiga
  135.                     Command Line Interface (CLI). If you don't yet
  136.                     have these skills, you won't be able to edit Nag's
  137.                     config file, but you can still use Nag with the
  138.                     default s:Nag.config that comes in the Arc file.
  139.  
  140. *********************************************************************
  141. ***********************   3. Configuration   ************************
  142. *********************************************************************
  143.  
  144. 3.0   AUTO-CONFIGURATION
  145.  
  146.      You may use the 'Nag.install' file to automatically copy the
  147. required files to the proper places in your system for the sample
  148. s:Nag.config file. (Requires about 70k with SOUND sample).
  149. To make this happen:
  150.           1> cd to the directory containing all the Nag files, and
  151.           2> execute Nag.install
  152.           
  153. 3.1   EDITING THE CONFIGURATION FILE
  154.  
  155.    This file (s:Nag.config), can be edited with most editors or word
  156. processors. The 'Ed' that comes with your WorkBench works fine.
  157.    MAINTAIN THE FORMAT! (same # of lines, data starts on space 11,
  158. spaces on either side of data, etc.), or Nag will get confused!
  159.  
  160. sayFirst: The first half of the first thing the voice will say.
  161. sayFirst: The second half of the first thing the voice will say.
  162.  
  163.   Buffer: Size of the buffer in bytes.
  164.            The buffer needs to be big enough to hold both this year and
  165.            next year's files plus what you plan to add when editing.
  166.            (Minimum size = 2,000 bytes, Maximum size = 2,048,000 bytes.
  167.            If you try to use an out of range buffer size, Nag will
  168.            choose the closest valid value. To determine how large a
  169.            buffer you require, add the filesizes of the Nag.year files,
  170.            (Nag.thisyear + Nag.nextyear), plus an additional 1000 bytes
  171.            or so as Editing space. The structure of the nag entries has
  172.            been made as memory efficient as possible, so a single event
  173.            will take, AT MOST, 60 bytes in the Nag.year file.
  174.  
  175.   nagDir: Full path to the Nag.1988, Nag.1989, etc. files. Nag looks for
  176.            a space to tell where any Path string ends, so don't put any
  177.            embedded spaces within the nagDir Path or in the soundFile
  178.            path! See the system directory for the file sizes. 20,000
  179.            bytes is likely to be sufficient for all but the busiest
  180.            bureaucrat.
  181.  
  182.   bdHour: Default hour. Birthdays and other days with no specific hour
  183.            entered will be nagged at this hour. (military time!). 1600
  184.            hours, (4:00 pm), works well.
  185.  
  186.  nagFlag: NagFlag. 1=ON, 0=OFF.  If OFF, no nags will occur at all.
  187.   ssFlag: SingleShot Flag. 1=ON, 0=OFF. If ON, nags will not repeat
  188.            every 30 seconds.
  189.  
  190.  sayRate: VOICE: Words Per Minute.     150 is good     (   40 to   400)
  191. sayPitch: VOICE: Pitch of voice.   bass voice = 67     (   65 to   320)
  192.   saySex: VOICE: Sex and Mode of Voice. 0 or 2 = Male,1 or 3 = Female,
  193.                   greater than 1 = Robot  (male & female robots?)
  194.  sayFreq: VOICE: Sample Frequency. Default = 22200     ( 5000 to 28000)
  195.                   Fool with this at your own risk. Higher number gives
  196.                   Nag a lower sounding voice.
  197.  
  198.  sPeriod: SOUND: Time to play 1 byte in clock ticks    (  127 to 65535)
  199.            Period(in clock ticks) = (microsecs per sample)/0.279
  200.            So, if the SOUND was sampled at 10,000 samples per sec, that's
  201.            .0001 sec per sample, or 100 microseconds. 100/.279 = 358.
  202.            Sound sampled at 10,000 samples per second should have a
  203.            sPeriod of 358. (IFF SOUND files compute their own sPeriod.)
  204.  sVolume: SOUND: Volume. 0 = minimum     64 = maximum  (    0 to    64)
  205.  sCycles: SOUND: Cycles. Number of sound sample repeats(    1 to 65535)
  206.            This is mostly for the internal sound. Most SOUND samples will
  207.            have sCycles set to 1. When using the internal sample, try
  208.            setting sCycles from 2-20, and sPeriod from 127-1000. The
  209.            internal sample is 1024 bytes long and has silence built in
  210.            before and after the 'beep' so it will 'pulse' if sCycles are
  211.            set to greater than one.
  212.            
  213.   lPlace: Left Edge of the Tiny Window.                (    0 to   608)
  214.   tPlace: Top  Edge of the Tiny Window.                (    0 to   189)
  215.            If your WORKBENCH in in interlace, the top edge may go down
  216.            to 389. If bdFlag = 1, Nag will not allow a top edge less
  217.            than 2. (otherwise the TinyWindow would be hidden by the
  218.            title bar!)
  219.   bdFlag: bdFlag toggles Tiny Window.  Normal = 0,  BACKDROP = 1.
  220.            If bdFlag = 0, the Tiny Window acts like a normal window. You
  221.            may depth arrange other windows on the WORKBENCH screen in
  222.            front or in back of it. However, if bdFlag = 1, the Tiny Window
  223.            STAYS behind ALL other windows AND the WORKBENCH title bar.
  224.                    <NOTE: See Warning in section 6.1!>
  225.  
  226.      WBc: ColorFlag. 0 = Normal, 1 = Colors 1(white) & 3(red) are reversed.
  227.             (This may be of help if you use 'strange' WorkBench colors.)
  228.  
  229.    sPath: SOUNDfile path. Full path and filename for digital sound sample.
  230.            If the sample is IFF, the Period will be calculated and the
  231.            config file sPeriod will be ignored. If the config file has
  232.            the Cycles set to more than 10, Cycles will default to 1 to
  233.            play the digital sample. Volume is ALWAYS read from the
  234.            s:Nag.config file. Re-config reloads soundfile.
  235.  
  236.    mFlag: 'Missed Nags' flag. 0 = normal, 1 = skip the opening display
  237.             of 'You May Have Missed...' when Nag is first started.
  238.             If you RESET your Amiga a lot, you may not want to be
  239.             reminded of Missed Nags EVERY time. Set this flag to '1',
  240.             and when called in your startup-sequence, Nag will only
  241.             open the 'Tiny' window.
  242.  
  243. NOTE: Be sure to maintain the order and format of the configuration
  244. file or you will be in deep guano! Keep the vertical lines vertical,
  245. and the data starting on the 11th character. You may wish to keep a
  246. backup copy of the s:Nag.config just in case it all goes wrong! ;-) 
  247.  
  248. *********************************************************************
  249. ***********************   4. Installation    ************************
  250. *********************************************************************
  251.  
  252. 4.0 -  AUTO-INSTALLATION
  253.  
  254.     You may use the 'Nag.install' file to automatically copy the
  255. required files to the proper places in your system for the sample
  256. s:Nag.config file. (Requires about 60k with 15k SOUND sample.)
  257. To make this happen:
  258.           1> cd to the directory containing all the Nag files, and
  259.           2> execute Nag.install
  260.  
  261. 4.1   CONTENTS OF THE ARC FILE
  262.  
  263.     -* file *-        -*  purpose  *-            -* suggested location *-
  264.  
  265.       Nag              the program. Put in your        system drawer.
  266.       Nag.info         Tool icon for use from WBench   system drawer.
  267.       Nag1.info        a alternate tacky, chauvinistic icon  ;-)
  268.       Nag2.info        a time oriented icon 
  269.       Nag3.info        another tacky, chauvinistic icon.....
  270.       
  271.       Nag.config       this config file MUST be in your s: drawer.
  272.       Nag.config2      just a spare with alternate settings to try.
  273.  
  274.       Nag.1988         put this yearfile in your      system drawer.
  275.       Nag.1989         put this yearfile in your      system drawer.
  276.       Nag.1990         put this yearfile in your      system drawer.
  277.       Nag.year         See section 8.15 for uses of this file.
  278.       
  279.       Nag.doc          Instructions and helpful hints. A Must Read!
  280.                         (or you can wrap fish with the printout.)
  281.       Nag.PROMO        Advertisement
  282.       Nag.install      Execute this if you are confused and/or lazy.
  283.       ReadMeNow!       You should have read this already!
  284.  
  285.                    - Also included: -
  286.       RunBack          Allows Nag to run from startup-sequence.  c:
  287.       RunBack.doc      Documentation for RunBack.
  288.       ThruDaWindow     A IFF digitized sound effect.             s:
  289.  
  290. 4.2   NECESSARY FILES
  291.  
  292.          The only REQUIRED files are Nag (the program), 2 Nag.year
  293.           files (Nag.thisyear & Nag.nextyear), and s:Nag.config.
  294.           
  295.          if you start Nag from your startup-sequence, the program
  296.           RunBack (included in the arc file) is also needed.
  297.           
  298.          If you use the VOICE feature, the standard WORKBENCH files
  299.              devs:narrator.device  &  libs:translator.library
  300.                 must be available or the VOICE won't work.
  301.  
  302. *********************************************************************
  303. **********************  5. Getting Nag Started  *********************
  304. *********************************************************************
  305.  
  306. 5.0   Nag is intended to be run from your startup-sequence. Edit your
  307.        s:startup-sequence file so that one of the LAST lines, (AFTER
  308.        loadWB, if you use WORKBENCH, and AFTER the system time is SET),
  309.        is :
  310.                  RunBack -5 sys:system/Nag
  311.  
  312. 'RunBack', (included with Nag15.arc), should be in your c: directory.
  313.  
  314. 5.1   OR: To Start Nag From WORKBENCH, simply click on it's icon.
  315.  
  316. 5.2   OR: To Start Nag From CLI,   1> Run Nag
  317.        You may start Nag from any CLI, using "Run Nag", but you will
  318.        be unable to close this CLI while Nag is running.
  319.  
  320. *********************************************************************
  321. ********************  6. Tiny "Sleeping" Window  ********************
  322. *********************************************************************
  323.  
  324. 6.0 - General Info
  325.  
  326.     When first run, the word 'Nag' in contrasting colors will appear
  327. in the workbench display. This is Nag at rest. This 'Tiny Window' may
  328. be placed anywhere on your screen by setting lPlace (left edge) &
  329. tPlace (top edge) in the s:Nag.config file.
  330.  
  331. 6.1 - BACKDROP flag   ( 0 or 1 )
  332.  
  333.     If the BACKDROP flag in s:Nag.config is set to 0, the Tiny Window
  334. will be a normal, albeit small, window. (In this mode the Tiny Window
  335. will START in front and stay at whatever depth level you leave it.)
  336.  
  337.     If the BACKDROP flag is s:Nag.config is set to 1, the Tiny Window
  338. will STAY behind all other windows. In fact, in some ways, it is more
  339. like a disk icon than a window. It is even possible to slide the Tiny
  340. Window up under the WORKBENCH title. If, for instance, you set the
  341. TopEdge of the Tiny Window to 2, (tPlace in s:Nag.config), the only
  342. visible sign of Nag is a 30 pixel horizontal line in WORKBENCH color
  343. number 3 just under the title line.
  344.  
  345. WARNING!: If WORKBENCH is run (or re-run) AFTER Nag, and the bdFlag=1,
  346.            Nag's Tiny Window will disappear behind the WorkBench screen,
  347.            FOREVER!  Run WORKBENCH FIRST! (loadWB)  Then run Nag.
  348.  
  349. 6.2 - Awakening Nag
  350.  
  351.     Nag's Tiny Window will hang around waiting for one of THREE events.
  352.  
  353.       1.   The Timer signal arrives. (Time to remind you!)
  354.  
  355.        In this case, if the "Nag" or "1 Nag" gadget is "lit", the
  356.        "Nag Window" will pop up in front of all current screens
  357.        displaying the event which triggered it.
  358.         NOTE: If you are editing or searching when the Timer signal
  359.          arrives, that window will be closed before the Nag.
  360.         
  361.            YOU MUST PRESS THE LEFT MOUSEBUTTON INSIDE THE NAG
  362.            WINDOW TO ACKNOWLEDGE THE NAG AND MAKE IT GO AWAY!
  363.        
  364.         An un-acknowledged nag will repeat every 30 seconds
  365.         until it is acknowledged...   (soooo irritating... ;-)
  366.  
  367.       2.  You 'Click' on the word "Nag" in the Tiny Window.
  368.  
  369.         In this case, you are taken to the main display screen and
  370.         the current list of upcoming appointments is listed.
  371.  
  372.       3.  Upon startup, if a reminder has been missed.
  373.  
  374.        If there are UPCOMING EVENTS whose reminders have been missed
  375.        because Nag has just now started, Nag will open the MAIN DISPLAY
  376.        WINDOW when first run, and display what you missed. (Your
  377.        startup-sequence will continue in the background.) You may also
  378.        initiate this "Missing Nags Search" by 'SEARCH'ing for a single
  379.        character.
  380.  
  381.        NOTE: Missing Nags are always calculated from NOW.
  382.         
  383. *********************************************************************
  384. **********************  7. MAIN DISPLAY WINDOW  *********************
  385. *********************************************************************
  386.  
  387. 7.0 - The Top Line
  388.  
  389.     The top line displays today's time and date and the APPROXIMATE
  390. number of minutes until the next "nagged" event. The top line is
  391. updated whenever you move the mouse or select a gadget.
  392.  
  393. 7.1 - Appointment Display
  394.  
  395.      The current list of appointments is displayed in the large area
  396. on the left side of the main display window, each day "headered" with
  397. a date-line. If the appointment or event is within one week of NOW,
  398. the Day-Of-The-Week will be highlighted. 'Today' and/or 'Tomorrow',
  399. as they relate to NOW, will also be indicated.
  400.  
  401. 7.2 - Those Colored 'Dots'
  402.  
  403.      A 'dot' located between the time and the event indicates that 1 or
  404. more Nag Flags have been set. Black(color #2) = Flash, Red(color #3) =
  405. SOUND nag and White(color #1) = VOICE nag. To determine EXACTLY which
  406. flags and how many nags are set, use the Edit Screen. (see below)
  407.  
  408. 7.3 - The Calendar Display
  409.  
  410.      Dates are intially in black (color #2), then those dates which
  411. have an event are changed to red (color #3), or if there is a 'nagged'
  412. event, that date is changed to white (color #1). You can tell with a
  413. glance at the calendar when your next 'open' day will be. You may also
  414. REVERSE color #1 and color#3 by setting a flag in the s:Nag.config file.
  415.  
  416.    CREDIT:  Some calendar routines were borrowed from a public domain
  417.              program called "calendar". I hereby thank the author of
  418.              calendar, for saving me a lot of "grunt work"!
  419.  
  420. 7.4 - The Calendar Gadgets
  421.  
  422.     The YEAR and/or MONTH can be changed by pressing the left mouse
  423. button on the "<<<  >>>" marks. (Nag will not update the appointment
  424. display until a day of the month is chosen). The current day of the
  425. month can be changed by pressing the left mouse button on the selected
  426. day. Remember you can only view appointments from this year and next
  427. year although you may set the calendar for other years.
  428.  
  429. 7.5 - NOW gadget
  430.  
  431.     Resets Nag to current time and date.
  432.  
  433. 7.6 - NAG or 1 NAG gadget
  434.  
  435.     If this gadget is 'off', "Nag is gagged".
  436. If either Nag or 1 Nag is on (lit), the NAG feature is activated.
  437.    (1 Nag is selected by clicking 'NAG' twice and vice-versa.)
  438.  
  439.         NAG: When 'NAG' is lit, you are in standard Nag mode. When
  440. a nag event occurs, you must respond by clicking in the Nag window,
  441. or the Nag will continue to repeat every 30 seconds.
  442.  
  443.       1 NAG: When '1 NAG' is lit, ONLY ONE nag will appear for each
  444. nagged event. You DO NOT have to respond to the nag when this flag is
  445. lit. The Nag will show for 15-20 seconds and go away ATTEMPTING to
  446. return your machine to the way it was before the nag began.
  447.  
  448. 7.7 - EDIT gadget
  449.  
  450.     Takes you to the "Edit" Screen to edit the chosen date. (see below)
  451.  
  452. 7.8 - PRINT gadget
  453.  
  454.     Uses preferences thru PRT device to print hardcopy of selected
  455. appointments. (skips perforation if necessary).
  456.     Prodedure: Select start date, select PRINT, (gadget lights to
  457. indicate that PRINT is active), select end date, select PRINT again.
  458. When the display returns to show the start date, control has been
  459. returned to you. To print currently selected day, just double-click
  460. the PRINT gadget. (selecting a day starts the day from 12:01am,
  461. selecting NOW makes PRINT start from the current hour.
  462.   
  463. NOTE: IF YOU NEED TO ABORT THE PRINTING:
  464.       Turn off your printer, wait 30 seconds or so for the 'printer
  465.       trouble' requestor to appear, and select 'CANCEL'.
  466.       
  467. IF THAT DOESN'T WORK OR YOU ARE IMPATIENT:
  468.      Keep turning your printer on and off until control returns.
  469.        (Yes, I'd call this a bug, but NOT MINE.)
  470.  
  471. 7.9 - SEARCH gadget
  472.  
  473.     Makes a non case-dependent search of the "message" parts of the
  474. appointments for the entered string and displays each occurence on the
  475. main screen. A string of only one character will display all possibly
  476. 'missed' nags from 'Now'.
  477.  
  478. 7.10 - SHRINK gadget
  479.  
  480.      Closes the Main Display Window and exposes the Tiny Window.
  481. Clicking on SHRINK is the proper way to exit Nag. It remains ready,
  482. but in the background waiting. In addition, any changes in the year
  483. files are automatically saved in case the system goes down prematurely.
  484.  
  485. 7.11 - QUIT gadget
  486.  
  487.      REMOVES Nag from the operating system. Changes in the year files are
  488. saved before Nag gives up if you select 'Yes' when the Requestor pops up.
  489.  
  490. 7.12 - TITLE BOX gadget  (re-configure)
  491.  
  492.      The title box (lower right area) is also a gadget. It re-loads the
  493. config file and reconfigures ALL of Nag if you select the 'Yes' Requestor.
  494.  
  495. *********************************************************************
  496. *************************  8. EDIT SCREEN  **************************
  497. *********************************************************************
  498.  
  499. 8.0  - When are we editing?
  500.  
  501.     Nag only works on, and edits, THIS year and NEXT year. If you leave
  502. your Amiga running thru New Year's Eve, please 'QUIT' Nag and re-start
  503. to set the new year. (If you don't, Nag will continue to use the
  504. original yearfiles, and you will be unable to edit next year.)
  505.  
  506. 8.1  - What are we editing?
  507.  
  508.      You are editing the ONE day that was set on the `calendar' before
  509. you selected the "EDIT" gadget. The date being edited is displayed in
  510. the top line of the Edit screen.
  511.  
  512. 8.2  - The "string" gadget
  513.  
  514.      The long red rectangle, with the curser in it is the 'string'
  515. gadget. Enter your message here as the first step in the data entry
  516. process. Then the time and other gadgets may be set. This is the
  517. text that will be translated by translator and spoken by narrator
  518. if the VOICE is used.
  519.  
  520. 8.3  - The /\ and \/ gadgets
  521.  
  522.      All of the "/\" and "\/" thingies are gadgets. Starting from the
  523. upper left, the first set controls the hours, the 2nd set controls the 
  524. minutes, and the 3rd set controls the line number. You may have up to
  525. 99 lines per day. The hour control gadgets can be used to set certain
  526. visual flags (BIRTHDAY, ANNIVERSARY, !ACTION!) instead of a specific
  527. time. Just keep clicking one of the line number gadgets to cycle through
  528. all the possibilities. The AM/PM gadget can speed this process.
  529.  
  530. 8.4  - AM/PM gadget
  531.  
  532.      am/pm can be switched by selecting the am/pm gadget.
  533.  
  534. 8.5  - DELETE gadget
  535.  
  536.      Removes the currently displayed line from the edit buffer.
  537.      Remember to select 'DONE' when you are finished editing that
  538.      day to save your changes to the main buffer.
  539.  
  540. 8.6  - COPY gadget
  541.  
  542.      Copies the currently displayed line into the Copy buffer. The
  543. last event copied remains safe in the Copy buffer until you QUIT Nag.
  544. The copy buffer copies everything except the date so you can move what
  545. you copy to another day and/or month.
  546.  
  547. 8.7  - RECALL gadget
  548.  
  549.      Copies the Copy buffer into the currently displayed line. Using the
  550. COPY & RECALL functions makes entering repeated dates, (like User meetings,
  551. Car maintenence, "Washday"), etc. quick and painless.
  552.  
  553. 8.8  - Time gadgets
  554.  
  555.      At the upper right is the Nag 'Times' selection area. You may
  556. select any combination of time periods to be "nagged". (15 MIN, HOUR,
  557. DAY, WEEK, 30 DAYS and/or OnTime) previous to the "event".
  558.  
  559. 8.9  - Nags Per Time gadgets
  560.  
  561.      The fourth set of "/\ \/" gadgets controls the "Nags Per Time".
  562. This number is combined with each SELECTED Time to determine how
  563. often you will be 'nagged'.
  564.  
  565.      For example: if you have selected 1/4 Hourly, Hourly, and Daily,
  566. the nags per time is 2, and the "Nag" flag is "lit" on the  Main
  567. Display Screen, you will be reminded of the upcoming event at 48 hours,
  568. 24 hours, 2 hours, 1 hour, 30 minutes, and 15 minutes before the upcoming
  569. "event". Nag won't nag you at the exact time of the event unless you have
  570. set the "On Time" time.
  571.  
  572.      When a Time or Mode is selected, Nags Per Time will automatically
  573. advance to 1. When all are de-selected, nags will automatically go to 0.
  574. Note that if no Times or Modes are selected, Nags Per Time can NOT be set.
  575.      The maximum Nags Per Time is 7.
  576.  
  577. 8.10 - VOICE & SOUND  gadgets   (make some noise)
  578.  
  579.      Above the Nag Time Selection area are two Nag 'Mode' selection
  580. gadgets for 'VOICE' and 'SOUND'. You may select either, both or none
  581. for each event. None = flash (Amiga function DisplayBeep). If you want
  582. no nags at all, leave ALL flags OFF for this event, or turn off the NAG
  583. gadget on the Main Display Window. (The latter disables ALL nags)
  584.  
  585. NOTE: Settings for the VOICE and SOUND are in the Nag.config file.
  586.        Any file may be used as the SOUND file, but real digital samples
  587.        seem to work best. ;-)  If the file is in IFF format, the proper
  588.        Period will be computed, otherwise, the values in s:Nag.config
  589.        is used. If Nag cannot find your digital-sample-sound-file,
  590.        (sPath in s:Nag.config), it will use an internal 1024 byte
  591.        'pulse' wave as sound data with the s:Nag.config values.
  592.        After MUCH work, this is STILL an ugly sound. Maybe it was
  593.        destined to be. The program IS called Nag, ya know... ;-)
  594.  
  595. 8.11 - DONE  gadget
  596.  
  597.      Means you are satisfied with this day's appointments. (Changes
  598. will be saved automatically if you 'SHRINK', or Requestored if you
  599. 'QUIT' Nag.)
  600.  
  601. 8.12 - CANCEL  gadget
  602.  
  603.      Means you want Nag to `forget' this editing session. (no changes
  604. saved, everything the way it was before you started to edit.)
  605.  
  606. 8.13 - SHAREWARE  gadget  (Test Nag)
  607.  
  608.      The shareware message is also a gadget. It generates a TEST 'nag'
  609. using the event and settings you are currently editing. Nag will
  610. complain if you have failed to set a Mode and/or Time.
  611.  
  612. 8.14 - To Enter New Appointments:
  613.  
  614.      Make sure you are looking at the "Editing:" screen.
  615.      Use the Line # gadgets to move to a blank line. (highest #)
  616.      Type in the information to be displayed. (up to 45 characters)
  617.         Press RETURN to enter a new "message" string.
  618.      Then: If you want to be nagged, light at least one 'Time'or'Mode'.
  619.      (If you select VOICE and/or SOUND first, Nag assumes
  620.        you want an 'OnTime' nag and sets that Time for you.)
  621.  
  622. NOTE: You MUST enter a message string before you can set anything, and
  623. you MUST set at least one 'Time' or 'Mode' before it is possible to set
  624. the number of 'Nags Per Time'. (That makes sense, doesn't it?)
  625.  
  626. NOTE: To 'unset' nags, turn ALL flags OFF.
  627.        
  628. FINALLY!:  Select the 'DONE' gadget to 'save' the changes to the main
  629. buffers. (The buffers are saved to disk when you SHRINK or QUIT Nag.)
  630.  
  631.       You may test your new nag by selecting the Shareware Notice.
  632.  
  633.                       That's all there is to it!
  634.  
  635. You can watch your work updating the day's entries in the window below.
  636. When the day looks correct, REMEMBER to select "DONE" to save that day.
  637.  
  638. 8.15 - Merging and Sorting from CLI - (using the Nag.year file)
  639.  
  640.         Try entering all your birthdays, anniversaries, holidays, and
  641. other dates that don't change year to year into the generic 'Nag.year'
  642. file using a text editor. Then, when you need a new year, use the AmigaDog
  643. command 'copy', from CLI, to copy Nag.year to Nag.1990 (for example).
  644.         If you ALREADY have your Nag.1990 file, and you wish to MERGE
  645. the two files togeather, use the CLI commands 'Join' and 'Sort' to
  646. construct your new file and 'Copy' it to the proper directory.
  647.  
  648.         Example: (from CLI)
  649.  
  650.         Cd   RAM:
  651.         Copy sys:system/Nag.1990 Nag.old
  652.         Join Nag.old             Nag.year as Nag.join
  653.         Sort Nag.join            Nag.1990
  654.         Copy Nag.1990        sys:system
  655.  
  656. 8.16 - Editing Years Other Than 'ThisYear' and 'NextYear'
  657.  
  658.      Although Nag can only edit 'thisyear' and 'nextyear', you can
  659. easily 'fool' it with the 'DATE' command from CLI. Let's say that
  660. it is 1988 but you want to edit 1987 before you print it out as
  661. your personal diary for that period. Here's how to do it:
  662.  
  663.     First, 'Quit' Nag.
  664.  
  665.   (then, from CLI)    DATE  01-JAN-87  (the month and day don't matter)
  666.                       RUN   Nag
  667.  
  668.     Bingo! There you are back in 1987! Go ahead and finish editing
  669. and printing until you are finished with 1987.
  670.  
  671.  DON'T FORGET TO RE-SET THE DATE TO THIS YEAR WHEN YOU'RE THROUGH!
  672.  
  673. *********************************************************************
  674. *********************  9. Nag.year Format  **************************
  675. *********************************************************************
  676.  
  677.     The Nag.year files contain YOUR data. It is formated as follows:
  678.  
  679.     The first 8 characters are the date and time, ie, MMDDHHNN,
  680.      where MM = month, DD = day, HH = hours, NN = minutes.
  681.      Hours and minutes are in military (24 hour) time.
  682.      2400 hours = 'blank'        2500 hours = BIRTHDAY
  683.      2600 hours = ANNIVERSARY    2700 hours = !ACTION!
  684.  
  685.     The ninth and tenth characters are set to blanks, (the spacebar
  686.      character), if no 'Nag Times' are set.
  687.  
  688.     If one or more 'Nag Times' are set, the ninth character is the
  689.      nagCode + ASCII ';' (nagCode + 58)
  690.         Nag Times are bit-wise flags.
  691.            15 MIN = 1           HOUR   =  2      DAY   =  4
  692.            WEEK   = 8         30 DAYS  = 16    ON TIME = 32
  693.      so if the 15 MIN and WEEK flags are selected, the nagCode is
  694.      1 + 8 = 9, and the ninth character is 9+58=67, or ASCII 'C'.
  695.     Likewise the tenth character = Nags Per Time + modes + 48. ('0')
  696.      Here the modes are VOICE = 8, and SOUND = 16. So, if you had set
  697.      two Nags Per Time, and selected both the SOUND and VOICE modes,
  698.      the tenth character would be 2 + 8 + 16 + 48 = 74 or ASCII 'J'.
  699.  
  700.     The words you entered for this date and time start on the 11th
  701.      character, and are limited to 48 characters. (58 characters total)
  702.  
  703.     The data MUST! be ordered from top to bottom with January at the
  704.      top. You can use the CLI command 'SORT' to put your Nag.year
  705.      files in order, see section 8.15 for an example.
  706.      
  707.  
  708. *********************************************************************
  709. ***********************  10. KNOWN BUGS  ****************************
  710. *********************************************************************
  711.  
  712. 10.0 - 'Top Line is Garbled' Bug
  713.  
  714.      Sometimes all of the top line on the MAIN and/or EDIT windows
  715. will not display, allowing whatever was there before shine thru. Less
  716. often garbled characters will appear part-way through the top line.
  717.  
  718.      I have been unable to detect any problems associated with this
  719. 'quirk' other than momentary irratation with the display, and it can
  720. easily be fixed by selecting ANY gadget. None-the-less, I would like
  721. this kill this pesky insect. If anyone knows why this is happening,
  722. I would GREATLY appreciate a phone call, card, letter, or E-Mail.
  723.   (see Section 11 of this document for 'how to reach me' info.)
  724.  
  725. *********************************************************************
  726. ***********************  11. REVISIONS  *****************************
  727. *********************************************************************
  728.      - Nag  Revisions:  Written in Manx Aztec 'C' Version 3.4 -
  729. Version
  730. 1.6  03/22/88   Started over from 1.4 - Redid all of 1.5 revision.
  731.  39512 bytes     Found a few more routines to 'optimize'.
  732.                  Added 'Skip Missed Nags' flag to s:Nag.config.
  733.                  Killed the garbled top line bug?
  734.                  Fixed the 'VOICE sometimes speaks wrong day' bug.
  735. 1.5  03/04/88   Re-worked & de-bugged the internal SOUND routines.
  736.  39720 bytes     Re-config 'takes' the FIRST time now in ALL cases.
  737.                  Killed the 'Nag occurs while editing may Guru' bug.
  738.                  Re-worked graphics routines for smaller code size.
  739.                  Added time (HH:MM) to the top line which is now
  740.                  updated by any mouse movement or selection.
  741.                  Replaced SetWindowTitles() with Text(). (less code)
  742.                  DELETE is now only permenent if combined with DONE.
  743. 1.4  02/10/88   All allocations made MEMF_PUBLIC. (got nuthin' ta hide.)
  744.  41644 bytes     AllocMem() & CloseWindow() replaced with SafeAllocMem()
  745.                  and CloseWindowSafely(). Saved a few more code bytes.
  746.                  NagWindow 'select' more aesthetically pleasing. ;-)
  747.                  Re-organized & cleaned up source code. (neatness counts!)
  748. 1.3  01/31/88   Print routine no longer leaves printer in italics.
  749.  41584 bytes     Tomorrow displayed correctly for ALL dates.
  750.                  Tiny window no longer 'stores' mouse clicks.
  751. 1.2  01/24/88   Missed Nags no longer trashes the date in the title line.
  752.  41652 bytes     30 Day Nag now works right. Missed Nags always from NOW.
  753.                  Corrected spelling of 'to(m)morrow'. More Code Shrunk.
  754.                  Line Buffer now de-allocates (6k) when not needed.
  755.                  Complete re-write of docs. Fixed 'Edit 99th line' bug.
  756.                  Fixed the 'if no SoundFile you get long noise' bug.
  757. 1.1  01/09/88   More Initialization to 'Bullet-proof' everything.
  758.  42000 bytes     Fixed the 'Buy Some RAM!' bug. (Folks with No Fast_RAM.)
  759.                  No more crashes after displaying nag!
  760. 1.0  01/03/88   Skip over VOICE/SOUND problems to avoid 'requestor hang'.
  761.                  Add Reverse Colors Switch to s:Nag.config file.
  762.                  Re-Config now reconfigures EVERYTHING immediately.
  763.                  Rewrote docs. "NULLs? We doan need no #$%@ing NULLS!"
  764.                  Shorter Error Messages. Rewrote code for smaller size.
  765.                  Load SOUNDfile and IFF info (if available).
  766.                  Added Nag 'dots' to main display. Killed more bugs.
  767.                  Set Tiny Window to BACKDROP in s:Nag.config file.
  768. 0.9  12/12/87   Tiny Window: smaller, placement in s:Nag.config
  769.                  YearFiles: More idiot-proofing.
  770. 0.8  12/09/87   Reworked Nag Flag Selection Routines. NULLed ALL strings.
  771. 0.7  12/07/87   Shorten code. More error message handling. ReLoad Config.
  772.                  Save Requestor for 'QUIT'.
  773. 0.6  12/03/87   Kill Requestors during Nags. (& Req bug).
  774.                  Reworked Sound routine.
  775. 0.5  11/28/87   Added: Config File, Voice, Sound, & Print. Missed Nags
  776.                  on demand. On Time Flag. Better error reporting.
  777.                  Test Nag. Displays made 199 lines high, not 200.
  778. 0.4  11/07/87   Too many people with non-standard WB colors, so changed
  779.                  Calendar display of nags to colors. Minor cosmetics...
  780. 0.3  11/04/87   Changed nag mark to shadows. Fixed the bug
  781.                  that caused wrong year after some Edits.
  782. 0.2  11/03/87   Fixed some minor display bugs. Nags marked on calendar.
  783. 0.1  11/02/87   Fixed Beep Bug. Changed ^ to ~. Improved docs.
  784.                  Display 'Missed' Nags on startup.
  785. 0.0  10/29/87   Initial shareware release.
  786.  
  787. *********************************************************************
  788. ************************   12. SHAREWARE   **************************
  789. *********************************************************************
  790.  
  791. 12.0 - The Concept:
  792.  
  793.      Quality software you get to try in your own computer environment
  794. at little or no cost.
  795.                 
  796. 12.1 - The Pitch:
  797.  
  798.      If you find that you continue to use this software, a $10 donation
  799. to the author is encouraged and will place your name on the official
  800. "user's list". $15 or more will also get you a disk with the latest
  801. versions of Nag and other shareware. You may make your shareware
  802. donation in the form of a PLink or Genie gift to RLStockton.
  803.  
  804. 12.2 - The Address:
  805.                        Richard Lee Stockton (Nag)
  806.                        21305 60th West
  807.                        Mountlake Terrace, WA 98043
  808.                 
  809. 12.3 - Bug Reports:
  810.                        Send to the above address (US Snail) OR:
  811.                        EMail: RLStockton  on  GENIE & PLINK OR:
  812.                        call (voice only!) (206) 776-1253 (Seattle area)
  813.  
  814. 12.4 - Distribution:
  815.  
  816.      May not distributed for profit without prior written permission
  817. from me. Individuals ARE encouraged to copy and give away Nag15.arc to
  818. their friends (and enemies) and in addition; Fred Fish, Amicus and/or
  819. other public distribution services of like intent are hereby given
  820. permission to distribute Nag as long as the contents of the arc file
  821. and all copyright notices remain intact.
  822.  
  823. 12.5 -  The Promise:
  824.  
  825.      I shall maintain (and update as necessary) this shareware product
  826. in an effort to make it the BEST software of it's type, commercial or
  827. otherwise.
  828.  
  829. ************************************************************************** 
  830. ***************   La lingua de Amiga? Si! Poco a poco!   *****************
  831. **************************************************************************
  832. ******  DON'T  PAY  BIG  BUCKS!   ***   SUPPORT  AMIGA  SHAREWARE! *******
  833. **************************************************************************
  834. Nag Version 1.6 (c) 1987-1988 Richard Lee Stockton (released as shareware) 
  835. **************************************************************************
  836.  
  837.